internal: (studio) set up hot reloading for the studio bundle #31796
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cypress
|
||||||||||||||||||||||||||||||||||||||||
| Project |
cypress
|
| Branch Review |
ryanm/internal/hot-reloading
|
| Run status |
|
| Run duration | 18m 59s |
| Commit |
|
| Committer | Ryan Manuel |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
13
|
Pending
|
1232
|
Skipped
|
0
|
Passing
|
32181
|
| View all changes introduced in this branch ↗︎ | |
UI Coverage
45.83%
|
|
|---|---|
|
Untested elements
|
190
|
|
Tested elements
|
165
|
Accessibility
92.74%
|
|
|---|---|
|
Failed rules
|
3 critical
9 serious
2 moderate
2 minor
|
|
Failed elements
|
697
|
ryanthemanuel
commented
May 29, 2025
…/test/unit/cloud/get_cloud_metadata_spec.ts
…est/unit/cloud/get_cloud_metadata_spec.ts
…/test/unit/cloud/get_cloud_metadata_spec.ts
…est/unit/cloud/get_cloud_metadata_spec.ts
…/test/unit/cloud/get_cloud_metadata_spec.ts
…est/unit/cloud/get_cloud_metadata_spec.ts
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the studio bundle loading and enables hot reloading of the local studio bundle by:
- Introducing
ensureStudioBundleandgetCloudMetadatahelpers and updating theStudioLifecycleManagerto use them. - Updating tooling snapshots, scripts, and the pack hook to reference the new studio files.
- Adding file‐watching logic in Gulp tasks and the lifecycle manager for local‐path‐based development.
Reviewed Changes
Copilot reviewed 22 out of 22 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| tooling/v8-snapshot/cache/linux/snapshot-meta.json | Replaced old studio manager snapshot entries with new studio files |
| tooling/v8-snapshot/cache/darwin/snapshot-meta.json | Same updates for Darwin snapshots |
| scripts/gulp/tasks/gulpCloudDeliveredTypes.ts | Switched to ensureStudioBundle and added chokidar watchers |
| scripts/after-pack-hook.js | Updated paths and validations for new studio files |
| packages/server/lib/cloud/studio/ensure_studio_bundle.ts | New helper for downloading and extracting the studio bundle |
| packages/server/lib/cloud/studio/StudioLifecycleManager.ts | Refactored to use new helpers, add caching, and hot-reload logic |
| packages/server/lib/cloud/get_cloud_metadata.ts | New utility to fetch cloud URL and headers |
| packages/server/lib/project-base.ts | Switched to getCloudMetadata for unified cloud config |
Various test files in packages/server/test/unit/cloud/studio |
Adjusted imports and added tests for new modules |
packages/server/test/unit/cloud/studio/StudioLifecycleManager_spec.ts
Outdated
Show resolved
Hide resolved
astone123
reviewed
May 29, 2025
We worked through this offline. There were some issues on @astone123's machine with watching files in general. |
mschile
reviewed
May 29, 2025
mschile
reviewed
May 29, 2025
mschile
reviewed
May 29, 2025
mschile
reviewed
May 29, 2025
mschile
reviewed
May 29, 2025
mschile
reviewed
May 30, 2025
| StudioLifecycleManager.watcher = chokidar.watch(path.join(process.env.CYPRESS_LOCAL_STUDIO_PATH, 'server', 'index.js'), { | ||
| awaitWriteFinish: true, | ||
| }).on('change', async () => { | ||
| await this.studioManager?.destroy() |
There was a problem hiding this comment.
Let's add a console.log here so we have an indicator that the server has reloaded.
mschile
approved these changes
May 30, 2025
|
Released in This comment thread has been locked. If you are still experiencing this issue after upgrading to |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Additional details
This PR sets up hot reloading for the cloud delivered studio code when
CYPRESS_STUDIO_LOCAL_PATHis set. When that environment variable is set, we set up a watcher for the server file and trigger the studio life cycle manager loading promise when that file changes. This promise will eventually resolve with the new studio code and notify the appropriate listeners of the update (note that we don't clean up the listeners when the environment variable is set). Some additional code streamlining has also been done to make this watching a little bit easier to implement.Steps to test
How has the user experience changed?
PR Tasks
cypress-documentation?type definitions?